/*
 * Copyright (C) 2011-2014 GUIGUI Simon, fyhertz@gmail.com
 *
 * This file is part of libstreaming (https://github.com/fyhertz/libstreaming)
 *
 * Spydroid is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This source code is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this source code; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package net.majorkernelpanic.screening;

import java.io.IOException;
import java.io.OutputStream;
import java.net.InetAddress;

/**
 * An interface that represents a Stream.
 */
public interface Stream {

  /**
   * Configures the stream. You need to call this before calling {@link #getSessionDescription()}
   * to apply your configuration of the stream.
   */
  public void configure() throws IllegalStateException, IOException;

  /**
   * Starts the stream.
   * This method can only be called after {@link Stream#configure()}.
   */
  public void start() throws IllegalStateException, IOException;

  /**
   * Stops the stream.
   */
  public void stop();

  /**
   * Sets the Time To Live of packets sent over the network.
   * @param ttl The time to live
   * @throws IOException
   */
  public void setTimeToLive(int ttl) throws IOException;

  /**
   * Sets the destination ip address of the stream.
   * @param dest The destination address of the stream
   */
  public void setDestinationAddress(InetAddress dest);

  /**
   * Sets the destination ports of the stream.
   * If an odd number is supplied for the destination port then the next
   * lower even number will be used for RTP and it will be used for RTCP.
   * If an even number is supplied, it will be used for RTP and the next odd
   * number will be used for RTCP.
   * @param dport The destination port
   */
  public void setDestinationPorts(int dport);

  /**
   * Sets the destination ports of the stream.
   * @param rtpPort Destination port that will be used for RTP
   * @param rtcpPort Destination port that will be used for RTCP
   */
  public void setDestinationPorts(int rtpPort, int rtcpPort);

  /**
   * If a TCP is used as the transport protocol for the RTP session,
   * the output stream to which RTP packets will be written to must
   * be specified with this method.
   */
  public void setOutputStream(OutputStream stream, byte channelIdentifier);

  /**
   * Returns a pair of source ports, the first one is the
   * one used for RTP and the second one is used for RTCP.
   **/
  public int[] getLocalPorts();

  /**
   * Returns a pair of destination ports, the first one is the
   * one used for RTP and the second one is used for RTCP.
   **/
  public int[] getDestinationPorts();

  /**
   * Returns the SSRC of the underlying {@link net.majorkernelpanic.screening.rtp.RtpSocket}.
   * @return the SSRC of the stream.
   */
  public int getSSRC();

  /**
   * Returns an approximation of the bit rate consumed by the stream in bit per seconde.
   */
  public long getBitrate();

  /**
   * Returns a description of the stream using SDP.
   * This method can only be called after {@link Stream#configure()}.
   * @throws IllegalStateException Thrown when {@link Stream#configure()} wa not called.
   */
  public String getSessionDescription() throws IllegalStateException;

  public boolean isStreaming();
}
